// 
// Copyright (c) 2006-2009 Ben Motmans
// 
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
//
// Author(s):
//    Ben Motmans <ben.motmans@gmail.com>
//

using System;

namespace Anculus.Core
{
	/// <summary>
	/// 
	/// </summary>
	public interface ILogBackend
	{
		bool IsOpen { get; }
		
		ILogFormatter LogFormatter { get; set; }

		/// <summary>
		/// Opens the log backend.
		/// </summary>
		void Open ();

		/// <summary>
		/// Writes the specified log entry to the log.
		/// NOTE: this method should never throw an exception, e.g.: if <paramref name="entry"/> if null, no action should be taken.
		/// </summary>
		/// <param name="raw">The raw message.</param>
		void WriteEntry (LogEntry entry);

		/// <summary>
		/// Writes the specified raw message to the log.
		/// NOTE: this method should never throw an exception, e.g.: if <paramref name="raw"/> if null, no action should be taken.
		/// </summary>
		/// <param name="raw">The raw message.</param>
		void Write (string raw);

		/// <summary>
		/// Closes the log backend.
		/// </summary>
		void Close ();

		/// <summary>
		/// Loads the settings from a config file.
		/// </summary>
		/// <param name="section">The section defining the ILogBackend parameters.</param>
		void LoadSettings (IConfigurationSection section);
	}
}